Water - Kareha & Leah #5

scottzec · 2020-10-09T04:53:14Z

Assignment Submission: Slack CLI

Congratulations! You're submitting your assignment. Please reflect on the assignment with these questions.

Reflection

Question	Answer
How did you go about exploring the Slack API? Did you learn anything that would be useful for your next project involving an API?	We spent time trying to understand the arguments that each method accepted. We also lingered on certain points, i.e. what type of recipient you could post a message to, in the method documentation pages.
Give a short summary of the request/response cycle. Where does your program fit into that scheme?	The human user makes a request via the CLI to our program, the client. Our program returns an appropriate response to the user containing information it received from the server via the API.
How does your program check for and handle errors when using the Slack API?	If the GET request isn't successful for any reason, the SlackAPI Error is raised. We check that our GET requests are successful every time we use the API. We return a string to check that the send message method successfully POSTs that message.
How did the design and organization of your project change over time?	Our design we sketched on Monday evening was fairly similar to Ada's design. We then worked within that framework for the duration of the project.
Did you use any of the inheritance idioms we've talked about in class? How?	We used Recipient, an abstract class. We defined template methods in that abstract class and used them throughout our subclasses User, Channel and Workspace.
How does VCR aid in testing a program that uses an API?	Instead of continually creating new API calls that could cause our API to overwhelm Slack's servers and potentially negatively affect our access, VCR runs the API call one time and saves a "recording" of that call for future tests to access instead of a new API call.

beccaelenzil

Slack CLI

Major Learning Goals/Code Review

Criteria	yes/no, and optionally any details/lines of code to reference
Practices best practices working with APIs. The `.env` is not checked into git, and no API token was directly used in the Ruby code without `ENV`.	✔️
Practices error handling with APIs. For all pieces of code that make an API call, it handles API requests that come back with errors/error status codes appropriately.	✔️
Implements inheritance and inheritance idioms. There is a `Recipient` class. `User` and `Channel` inherit from `Recipient`. In `Recipient`, there are appropriate methods defined that are used in both `User` and `Channel`. Some may be implemented. Some may be template methods.	✔️
Practices clean code. `lib/slack.rb` only interacts with `Workspace` to show a separation of responsibilities. Complex logic is broken into smaller helper methods.	✔️
Practices instance methods vs. class methods appropriately. The methods to list all Channels or Users is likely a class method within those respective classes.	✔️
Practices best practices for testing. The project has and uses VCR mocking when running tests, and can run offline.	✔️
Practices writing tests. The `User`, `Channel`, and `Workspace` classes have unit tests.	✔️
Practices writing tests. There are tests for sending messages (the location of these tests may differ, but is likely in `Recipient`)	✔️
Practices git with at least 15 small commits and meaningful commit messages	✔️

Functional Requirements

Functional Requirement	yes/no
As a user of the CLI program, I can list users and channels	✔️
As a user of the CLI program, I can select users and channels	✔️
As a user of the CLI program, I can show the details of a selected user or channel	✔️
As a user of the CLI program, when I input something inappropriately, the program runs without crashing	If I try to send a message before selecting a user/channel, the error bubbles up. Consider how you could gracefully handle this.

Overall Feedback

Excellent job overall. This code is well-written and well-tested. It is clear to me that the learning goals around understanding the request/response cycle, consuming an API, and implementing a design using inheritance from scratch were all met.

I've left a few inline comments for you to review below focused on ways to enhance user experience. The logic in the slack.rb code allows exceptions to bubble up to the user.

Of particular note, you've done a great job breaking out functionality into helper methods. Keep up the hard work!

Overall Feedback	Criteria	yes/no
Green (Meets/Exceeds Standards)	7+ in Code Review && 3+ in Functional Requirements	✔️
Yellow (Approaches Standards)	6+ in Code Review && 2+ in Functional Requirements
Red (Not at Standard)	0-5 in Code Review or 0,1 in Functional Reqs, or assignment is breaking/doesn’t run with less than 5 minutes of debugging

Code Style Bonus Awards

Was the code particularly impressive in code style for any of these reasons (or more...?)

Quality	Yes?
Descriptive/Readable	✅
Concise	✅
Logical/Organized	✅

beccaelenzil · 2020-10-19T19:52:44Z

lib/slack.rb

+def validate_property_type(property_type)
+  property_type.downcase!
+  valid_property_types = ["name", "id"]
+  return false unless valid_property_types.include?(property_type)


Nice use of a postfix conditional.

beccaelenzil · 2020-10-19T19:52:46Z

lib/slack.rb

+  until validate_property_type(property_type)
+    puts "Please enter either name or ID"
+    property_type = gets.chomp
+  end


Great use of a helper method.

beccaelenzil · 2020-10-19T19:52:48Z

lib/slack.rb

+  if recipient == nil
+    puts "This #{recipient_string} doesn't exist! Exiting..."
+  end


Consider writing this as a postfix conditional.

beccaelenzil · 2020-10-19T19:52:52Z

lib/workspace.rb

+    end
+    @selected = selected_user
+
+    return selected_user


Consider whether selected_user needs to be returned, as it is stored in the instance variable @selected

beccaelenzil · 2020-10-19T19:53:21Z

lib/workspace.rb

+    if property == "id"
+      selected_channel = channels.find{|channel_instance| channel_instance.slack_id == channel}
+    elsif property == "name"
+      selected_channel =  channels.find{|channel_instance| channel_instance.channel_name == channel}
+    end


Great use of the enumerable method `find1

beccaelenzil · 2020-10-19T19:55:56Z

lib/recipient.rb

+  def validate_post(response)
+    raise SlackAPIError.new("API call failed with code #{response.code} and error #{response['error']}") if response["ok"] == false
+    return "Thank you this message was sent"
+  end


Great use of a helper method.

beccaelenzil · 2020-10-19T20:03:03Z

lib/slack.rb

+
+def validate_input(input)
+  input.downcase!
+  raise ArgumentError.new("Not a valid input") unless VALID_INPUT.include?(input)


Argument errors are great to raise in your source code, but in your CLI code, you should consider how you can handle invalid user input so that the error doesn't bubble up and the user gets the opportunity to correct their mistake.

agesak and others added 30 commits October 5, 2020 22:06

creating workspace class, fixing test_helper to hide token

5fd8d97

untracked?

efe46b5

Merge branch 'master' of https://github.com/scottzec/slack-cli

62b013b

created classes

8e4a590

repetitive

db879e6

Merge branch 'master' of https://github.com/scottzec/slack-cli

b128e3f

recipient constructor tests

1c42e9f

user constructor tests

f71d4d6

add .floo to .gitignore

b88137a

remove unnecessary requires

9edf491

Added Channel Tests

b7d28f6

re-added driver file

867e2f1

Outline Wave 1 finished

1c9c5d7

functioning tp for Channels class

28b3ded

added User tests for API

6887969

testing User.list_all

dd3a077

adding Channel.list_all tests

0126e2d

wave 1 complete

7f6c7a8

Merge branch 'master' of github.com:scottzec/slack-cli

e499158

yml

f0e8f47

yml

33f18dd

refactor program_prompt in slack.rb

e138531

Merge branch 'master' of https://github.com/scottzec/slack-cli

d568925

select and show channel details in workspace

25e588e

select channel method tests

4813d03

select channel method tests

f4fc1b8

user select user and show details in workspace

0dd2c66

completed wave 2 tests

a332585

Merge branch 'master' of github.com:scottzec/slack-cli

a4dffe6

Removed superfluous name variable

7f5f160

agesak and others added 12 commits October 8, 2020 11:49

fixing bug in validate_input in slack.rb

f01557c

send message working for channels only when already selected

ce90722

send message to channel done

2ea8492

send message to channel done

9adbf30

reverting a commit

3c9bcc7

completed channel send msg

cba84f3

re-added validate_post to recipient

b8f539d

added 2 tests for send message

16a790a

validate name or id

a243c78

more use channel topic output

19159cd

final formatting

66f7256

add driver to .gitignore

f61aa6a

beccaelenzil reviewed Oct 19, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Water - Kareha & Leah #5

Water - Kareha & Leah #5

scottzec commented Oct 9, 2020

beccaelenzil left a comment

beccaelenzil Oct 19, 2020

beccaelenzil Oct 19, 2020

beccaelenzil Oct 19, 2020

beccaelenzil Oct 19, 2020

beccaelenzil Oct 19, 2020

beccaelenzil Oct 19, 2020

beccaelenzil Oct 19, 2020

Water - Kareha & Leah #5

Are you sure you want to change the base?

Water - Kareha & Leah #5

Conversation

scottzec commented Oct 9, 2020

Assignment Submission: Slack CLI

Reflection

beccaelenzil left a comment

Choose a reason for hiding this comment

Slack CLI

Major Learning Goals/Code Review

Functional Requirements

Overall Feedback

Code Style Bonus Awards

beccaelenzil Oct 19, 2020

Choose a reason for hiding this comment

beccaelenzil Oct 19, 2020

Choose a reason for hiding this comment

beccaelenzil Oct 19, 2020

Choose a reason for hiding this comment

beccaelenzil Oct 19, 2020

Choose a reason for hiding this comment

beccaelenzil Oct 19, 2020

Choose a reason for hiding this comment

beccaelenzil Oct 19, 2020

Choose a reason for hiding this comment

beccaelenzil Oct 19, 2020

Choose a reason for hiding this comment